home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / tribbs / us104.zip / US10.DOC < prev    next >
Text File  |  1996-04-12  |  23KB  |  447 lines
  1.                         UserScan 10.4 for TriBBS 10.x
  2.                                 By: Marc Brooks
  3.  
  4. This is a PostCardWare Sysop Utility for TriBBS 10.x ONLY. This utility will
  5. not work on version 5.x of TriBBS and if you try to use it on that version you
  6. will seriously screw your user files up. If you want a good TriBBS 5.x Sysop
  7. utility, try Keith Kolbo's UserScan/UserDoor 5.0 which is the util that
  8. inspired this one. If you have TriBBS 10.x then this is the Sysop Utility for
  9. you! This little utility does just about everything! If you decide to use this
  10. program please send a post card or note to the author at the address mentioned
  11. at the end of this doc so that we know to support this program in the future.
  12. If you send us $20 we will give you a copy of this utility's source code for
  13. your own personal reference or use.
  14.  
  15. Now for details. This is a DOOR program so you either have to run it in LOCAL
  16. mode shelled at the Waiting for Callers screen or from the Main or Sysop Menu
  17. inside TriBBS. Here is what a sample batch file will look like to run this
  18. shelled to DOS at the Waiting for Callers screen:  A sample US.BAT is included
  19. in this archive.
  20.  
  21. =============================================================================
  22.                                  BATCH FILES
  23. =============================================================================
  24.  
  25. Name of batch file: US10.BAT
  26.  
  27. CD \TRIBBS\USCAN10
  28. US10 US10.CFG LOCAL
  29. CD \TRIBBS\NODE1
  30. EXIT
  31.  
  32. Here is a sample batch file of running it from the Sysop Menu:
  33.  
  34. Name of batch file: SYSU.BAT
  35.  
  36. CD \TRIBBS\USCAN10
  37. US10 US10.CFG
  38. CD \TRIBBS\NODE1
  39. BOARD
  40.  
  41. Note: If you use Non-Standard IRQ's you need to specify the IRQ on the
  42. command line after the config file like this:
  43.  
  44. US10 US10.CFG 7
  45.  
  46. =============================================================================
  47.                              CONFIGURATION FILES
  48. =============================================================================
  49.  
  50. You also need to make a configuration file for it. You can call the
  51. configuration file anything you want so long as you specify the name of the
  52. config file on the command line (ie., US10 ANYNAME.CFG). If you have multiple
  53. nodes it's a good idea to make a config file for each node and name then like
  54. this: US10.1, US10.2, US10.3 etc.. Here is a sample config file to go by:  A
  55. sample US10.CFG is included in this archive.
  56.  
  57. TRIBBS
  58. C:\TRIBBS\NODE1\
  59. Fire Escape's BBS Directory Headquarters
  60. Fire Escape
  61. 38400
  62. 0
  63. NODE1=C:\TRIBBS\NODE1\
  64. CONF=2
  65. MESS=C:\TRIBBS\USCAN10\VALIDATE.TXT
  66. LEVEL=20
  67. UPFILES=1
  68. UPKB=130
  69. TIME=60
  70.  
  71. In the above sample the following lines mean this:
  72.  
  73. LINE 1: Door data type (YOU CAN ONLY USE TRIBBS!)
  74. LINE 2: Path to Node's Door Data File. (Node's main directory)
  75. LINE 3: Your BBS Name
  76. LINE 4: Your Sysop Name
  77. LINE 5: Locked Baud Rate (0 = Not Locked)
  78. LINE 6: Registration Number (0 = Unregistered. PostCardWare = 0)
  79. LINE 7-13: Contains the PATH to Node 1 (REQUIRED) and Auto-validation info
  80.            which is OPTIONAL.
  81.  
  82. Path to TriBBS' Node #1 is indicated by a line beginning with NODE1=
  83.  
  84. Rest of the options are for the auto-validation option "V" in UserScan.
  85.  
  86. The conference to mail the user's validation letter into is specified by a
  87. line beginning with CONF= (NOTE: The conference numbering is "TriBBS style"
  88. which begins with the first conference as #1, not zero.)
  89.  
  90. The name of the text file containing the user's validation letter is specified
  91. by a line beginning with MESS=  (This file can contain @codes@ to personalize
  92. the message.)
  93.  
  94. If you want to use the "V"alidate option to change a validated user's security
  95. level you may specify it here by putting the new level number on the line
  96. beginning with LEVEL=
  97.  
  98. If you want to use the "V"alidate option to credit a validated user's UPLOADS
  99. (complimentary file credit etc..) you may specify it here by putting the 
  100. number of file credits on the line beginning with UPFILES= (NOTE: Any value
  101. specified will be added onto any current file upload count.)
  102.  
  103. If you want to use the "V"alidate option to credit a validated user's BYTES
  104. UPLOADED (complimentary file credit etc..) you may specify it here by putting
  105. the number of bytes on the line beginning with UPKB=  (NOTE: Any value
  106. specified will be added onto any current bytes uploaded count.)
  107.  
  108. If you want to use the "V"alidate option to credit a validated user with a 
  109. specific amount of time for the day you may specify it here by putting the
  110. amount of time in minutes on a line beginning with TIME=
  111.  
  112. All of the auto-validation lines are optional, but if you want to send a
  113. message to a user using this option you MUST provide a conference number on
  114. the line beginning CONF=
  115.  
  116. After you have created config files for your node(s), you should make sure you
  117. have a file named whatever you specified on MESS= line in the directory you
  118. specified on the MESS= line. I suggest keeping this message to less than 70
  119. columns in order to facilitate proper importing into the message conf you
  120. specified on the CONF= line.
  121.  
  122. =============================================================================
  123.                               USE AND FEATURES
  124. =============================================================================
  125.  
  126. The following is a feature list and a brief explaination of the command
  127. options. The program is completely memu driven so you shouldn't really need to
  128. refer to this very much.
  129.  
  130. -----------------------------------------------------------------------------
  131.                                   MAIN MENU
  132. -----------------------------------------------------------------------------
  133.  
  134. When you first enter the utility door it will look like this:
  135.  
  136.                  UserScan 10.0 by Marc Brooks
  137.  
  138.                  [N] Search by Name or Alias
  139.                  [P] Search by Password
  140.                  [#] Search by Phone Number
  141.                  [S] Search by Security Level
  142.                  [B] Search by Birthdate
  143.                  [E] Search by Expiration Date
  144.                  [M] Search by Access to Private Conferences
  145.                  [C] Search by Co-Sysop Privileges to Conferences
  146.                  [F] Search by Access to Private File Areas
  147.                  [U] Search by User Number
  148.                  [D] Dump User Results to a Text File
  149.                  [Q] Quit UserScan
  150.  
  151. You may select from the menu by typing the letter between the brackets [ ].
  152. Below is a brief explanation of each of the Main Menu Options above.
  153.  
  154. [N] Search by Name or Alias. You can enter the whole user name or alias or 
  155.     just the part you know. UserScan will search the entire userbase and 
  156.     present users which match the search string you have entered. After you
  157.     enter the search string, UserScan will ask you if you want users with
  158.     the string ANYWHERE in their name/alias? If you say NO, it will only 
  159.     find users whose name or alias BEGIN with the string you have specified.
  160.     If you say YES, it will locate and display users that have the string 
  161.     ANYWHERE in their name or alias.
  162.  
  163. [P] Search by Password. You can enter a whole or partial password and
  164.     UserScan will locate and display one by one any or all users which have
  165.     a password containing the search string you have specified anywhere in
  166.     the password.
  167.  
  168. [#] Search by Phone Number. You can enter either a whole phone number or
  169.     just the area code or just the area code and the first 3 digits. (for
  170.     example: 314 OR 314-555 or 314-555-0000) If you enter the entire phone
  171.     number, UserScan will locate and display any and all users with a phone
  172.     number matching the phone number you have specified. If you enter only
  173.     the area code portion, it will locate and display for you all the users
  174.     who have phone numbers that begin with the area code you have specified.
  175.     If you enter the area code AND the prefix (the first 3 digits of the 7
  176.     digit number) UserScan will locate and display one by one any users who
  177.     have phone numbers that begin with the same prefix that share the same
  178.     area code.
  179.  
  180. [S] Search by Security Level(s). You can enter a single security level like
  181.     10 or 15 if you want to locate all users with a specific security level.
  182.     Or you can specify a range of security levels with the + or the - OR
  183.     the > or the  < signs followed by a security level. The search will
  184.     include the security level you enter. For example, a >60 parameter would
  185.     locate and display all users who are a Security Level 60 or greater.
  186.     Typing +60 would accomplish the same thing. Typing -40 would locate and
  187.     display all users with a Security Level of 40 or under. Typing <40 would
  188.     accomplish the same thing.
  189.  
  190. [B] Search by Birthdate. You can enter an entire birthdate [mm/dd/yy format]
  191.     to locate all users with a matching date of birth. Or you can type just
  192.     the "mm" portion of the parameter to locate all users who have a birth
  193.     date in the same MONTH. Typing just the "mm/dd" part of the parameter
  194.     would further restrict the search to users with a birthdate on the
  195.     same DAY of the Month (regardless of the year of birth).
  196.  
  197. [E] Search by Expiration Date. Works the same as Search by Birthdate only
  198.     for the date of a user's subscription expiration.
  199.  
  200. [M] Search by Access to Private Conferences. IF you have conferences marked
  201.     as "PRIVATE" UserScan will display a menu of those conferences with the
  202.     conference number and prompt you to select the conference number of the
  203.     private conference you want to check user access on. You may enter the
  204.     number from the menu of Private Conferences and then UserScan will then
  205.     locate and display all users who have been granted ACCESS to the Private
  206.     Conference you have specified.
  207.  
  208. [C] Search by Co-Sysop Privileges to Message Conferences. This option will
  209.     display a menu listing of ALL your Message conferences. Once listed, you
  210.     then specify the conference you want to check Co-Sysop privileges on.
  211.     After you specify the conference number UserScan will locate and display
  212.     any users who have been granted Co-Sysop privileges for the specified
  213.     message conference.
  214.  
  215. [F] Search by Access to Private File Areas. IF you have file areas marked
  216.     a "PRIVATE" UserScan will display a menu of those file areas with the
  217.     file area number and prompt you to select the file area number of the
  218.     private file area you want to check user access on. You may enter the
  219.     number from the menu of Private File Areas and then UserScan will then
  220.     locate and display all users who have been granted ACCESS to the Private
  221.     File Area you have specified.
  222.  
  223. [U] If you know a user's USER NUMBER off the top of your head, you may enter
  224.     it here to search for that user and display their account info.
  225.  
  226. [D] For those occasions when you want a printed or text file listing of users
  227.     with certain criteria (like a listing of all the users with access to a 
  228.     private file area etc..) you can select this option to record the results
  229.     of a UserScan search to a text file. UserScan will prompt you to enter 
  230.     the name of the text file. You do not have to type the PATH. UserScan 
  231.     will output the results of any subsequent searches to the filename you 
  232.     have entered in the directory where your UserScan files are located. If
  233.     you exit UserScan without executing any searches after initializing this
  234.     feature, the file you specified will not be created. Once you select a 
  235.     search criteria, you will see UserScan "searching..." over and over. 
  236.     UserScan will not display the matches to the display screen though. When
  237.     it finishes, it will return to the main UserScan Menu. If you "Q"uit 
  238.     UserScan then and go to it's directory, you can then locate and print 
  239.     the file you told it to create. The format of the output file is like 
  240.     this:
  241.  
  242. User #         User Name         Alias        Phone Number        Birthdate
  243. ==============================================================================
  244. 10             John Doe          Johnny       314-555-5555        01/31/85
  245.  
  246.     The display will be wider than 80 columns since it is formatted for easy
  247.     importing into database programs (all fields are fixed-width).
  248.  
  249. [Q] Quit UserScan. You select "Q" to exit the UserScan Utility Door and 
  250.     return to either the DOS prompt or the BBS.
  251.  
  252. When can you use UserScan?
  253.  
  254.     UserScan is SAFE to use while users are ONLINE, so long as the user of the
  255. file you are actively EDITING isn't logged on. The only known exception to
  256. this rule is while ZCHAT is in use because it holds TRIBBS's user files open
  257. in non-shared mode while users are in that program. If you know of any other
  258. 3rd party programs that make UserScan unsafe to use at the same time please
  259. let us know. NOTE: You CAN do searches and view users with UserScan while
  260. ZChat is being run so long as you do NOT attempt to EDIT any of the users.
  261. (Zchat is a Telechat door often used as a replacement for TriBBS' internal
  262. Telechatting option).
  263.  
  264. -----------------------------------------------------------------------------
  265.                              USER EDITTING MENU
  266. -----------------------------------------------------------------------------
  267.  
  268. After you select an option from UserScan's Main Menu, you will get a user's
  269. account menu that looks something like this:
  270.  
  271. [N] Name: John Doe
  272. [A] Alias: Johnny                 Date of 1st Call: 01/01/96
  273. [P] Password: dork
  274. [@] Address: 555 Main Street      [L] # of Logons: 4
  275.     Address: Apt.205              [M] Messages: 2
  276.     City: Nowhere City            [U] Uploads: 4/3001K
  277.     State: IL                     [D] Downloads: 25/100043K
  278.     Country: USA                      Last Call: 03/01/96
  279.     Zip: 55555                      Xfers Today: 2/1837262K
  280. [#] Phone #: 111-555-5555                    Calls Today: 4
  281. [B] Birthdate: 01/31/85           [T] Time Left Today: 31
  282. [S] Sec Level: 20                 [X] Expiration Date: None
  283. [?] Expert Mode: Novice           [I] Initial Chat: Yes
  284. [E] Editor: Line                  [W] Waiting Check: No
  285. [Y] Protocol: None
  286. [K] Delete User: No
  287. [0] Lock Out: No
  288.  
  289. [!] UserGram         [F] Private Files         [C] Conference Info
  290. [V] Auto-Validate  [Z] Zap Today  [< or -] Previous  [> or +] Next
  291.  
  292.  
  293. If you want to edit something on the user's account you simply enter the
  294. letter in the [ ] to access that data field. Below is a brief description of
  295. the user editing options. 
  296.  
  297. [N] Edits the User's Name
  298. [A] Edits the User's Alias
  299. [P] Edits the User's Password
  300. [@] Edits the User's Addresses, City, State, Country and Zip Code fields.
  301.     You will be prompted for each item in the address section, to leave a
  302.     field as it is without editing it, just hit ENTER to bypass it and
  303.     move on to the next field. You don't have to re-type the same thing.
  304. [#] Edits the User's Phone Number
  305. [B] Edits the User's Birthdate
  306. [S] Edits the User's Security Level
  307. [?] Edits the User's Menu Toggle. You will be prompted to enter either
  308.     N for Novice Mode, X for Expert Modem or S for Super Expert Mode.
  309. [E] Edits the User's Default Message Editor. You will be prompted to
  310.     enter either N for No Default, L for Line Editor or F for Full Screen
  311.     editor.
  312. [Y] Edits the User's Default Transfer Protocol. You will be prompted to
  313.     enter either S for Select at time of transfer or a LETTER that corresponds
  314.     to the protocol from your TTPROT Menu or EXTPROT Menu.
  315. [K] Toggles whether the user is marked for deletion in the next user pack or
  316.     not.
  317. [0] Toggles whether the user is locked out of the BBS or not.
  318. [L] Edits the User's Number of Logons
  319. [M] Edits the User's Number of Messages Entered
  320. [U] Edits the User's Number of Files Uploaded and Bytes Uploaded
  321. [D] Edits the User's Number of Files Downloaded and Bytes Downloaded
  322. [T] Edits the User's Time Left for TODAY
  323. [X] Edits the User's Subscription Expiration Date
  324. [I] Toggles the User's Initial Availability for Chat Requests on or off
  325. [W] Toggles the User's Check for Waiting Mail during Login Check on or off
  326. [!] Lets you enter a 15 line text message to the user that is delivered
  327.     via user-specific logon screen (ie., 2431.BBS)
  328. [F] Toggles a user's access to PRIVATE File Areas. Selecting this will
  329.     bring up a menu of your private file areas. When you select the number
  330.     for the file area it will tell you whether the user has access to it or
  331.     not and prompt you "ALLOW USER ACCESS?" Y/n. You select "Q" to quit
  332.     this access menu and save the changes.
  333. [C] Toggles a user's access to PRIVATE Message conferences. Tells you whether
  334.     the user currently has access or not and prompts you "ALLOW USER ACCESS?"
  335.     Y/n. Also tells you whether a user has a conference queued or not, and
  336.     gives you the option of queueing it for him. Lastly it will tell you
  337.     whether a user is a "co-sysop" of a specified conference and prompts you
  338.     "MAKE CO-SYSOP OF CONF?" Y/n. You select "Q" for quit this access menu
  339.     and save the changes.
  340. [V] Auto-Validates a user by editing their security level, files uploaded,
  341.     bytes uploaded, time for the day and imports a message to them into a 
  342.     conference of your choosing all based on what you have in your UserScan
  343.     configuration file (summarized again here):
  344.        The conference to send the validation letter is specified by a line
  345.        beginning with CONF=
  346.        The file containing the validation letter is specified by a line
  347.        beginning with MESS=  This file can contain @codes@ to personalize
  348.        the message.
  349.        If setting the validated user to a specific level is desired, the
  350.        level is specified by a line beginning with LEVEL=
  351.        If giving the validated user upload FILE credits is desired, the
  352.        number of files ADDED is specified by a line beginning with UPFILES=
  353.        If giving the validated user upload Kbytes credit is desired, the
  354.        number of Kbytes ADDED is specified by a line beginning with UPKB=
  355.        If giving the validated user a specific amount of time for the day,
  356.        the amount in minutes should be specified by a line beginning
  357.        with TIME=
  358. [Z] Zaps a User's stats for THAT DAY ONLY. Zero's their XFer's Today, sets
  359.     their daily time limit to the system-configuration defined daily time
  360.     limit. It is as if they have not called or done anything file related 
  361.     that day. Good for resetting a user who has been erroneously docked for
  362.     aborted downloads. The next time that the user calls, TriBBS will think
  363.     this is their first call for the day and reset all their daily limits
  364.     according to their security level as defined in the DLIMITS.DAT.
  365. [<] This will take you BACK to the PREVIOUS USER in a search. Typing a -
  366.     will accomplish the same thing.
  367. [>] This will take you FORWARD to the NEXT USER in a search. Typing a + OR
  368.     hitting ENTER will accomplish the same thing.
  369. [ESC] Hitting the ESCAPE key will abort the search and return you to the
  370.     MAIN USERSCAN MENU. If you have edited and made changes to a user account
  371.     hitting ESC will cause USERSCAN to prompt you "Save Changes to this User?"
  372. [ENTER] Hitting ENTER will take you to the next user in a search until you
  373.     get to the last user in a search and then it will return to the Main
  374.     UserScan menu. Hitting ENTER will AUTOMATICALLY SAVE for you any changes
  375.     you have made to a user account without prompting you as to whether or
  376.     not you wish to save the changes.
  377.  
  378. That's how it all works!
  379.  
  380. =============================================================================
  381.                        CONTACTING ME AND REGISTRATION
  382. =============================================================================
  383.  
  384. If you have any enhancement requests or bug reports to make, you can call Fire
  385. Escape's BBS Directory HQ at (314) 741-0341 or (314) 741-9505. You can also
  386. leave internet mail to Marc Brooks at marcb@crl.com.
  387.  
  388. If you want the source code, send $20 to Marc Brooks (money order) at this
  389. address:
  390.                Marc Brooks
  391.                1700 Parktree Lane
  392.                St. Louis, Mo. 63138
  393.  
  394. Please include a mailing address and an internet address (if you have one) so
  395. we know where to send the source to. If you use this program and would like
  396. for us to support it, send a postcard or letter to the above address and let
  397. us know you are using this utility. If you don't think anyone is using this
  398. utility then we probably won't put out bug fixes or make any enhancements. So
  399. SEND us feedback!!! PLEASE!
  400.  
  401. As with all postcardware/freeware/shareware, we have tested this program on OUR
  402. TriBBS 10.x system and have no problems. But if you use it and it eats your
  403. userfiles we are sorry but that's too bad. We don't expect it to, but hey, you
  404. use everything at your own risk. Okay? So make backups frequently. It's a good
  405. idea!! :)
  406.  
  407. =============================================================================
  408.                                    HISTORY
  409. =============================================================================
  410.  
  411. 20 March 96: 10.0:  Internally release in use on our BBS
  412.  
  413. 02 April 96: 10.1:  First public release, added validation time option,
  414.                     corrected typo in expert (menu) prompt.
  415.  
  416. 02 April 96: 10.2:  MarkG got me with an April fools, the TBAPI doc for
  417.                     TBUsers_Dat.DefaultEditor does NOT take 'L' and 'F'
  418.                     for "line" and "full-screen" editors.  Rather, it takes
  419.                     1 and 2.  Thus, if you changed a user's default editor
  420.                     in UserScan 10.1, it would display incorrectly in TriBBS
  421.  
  422. 08 April 96: 10.3:  Was sending Usergrams to the MWORK directory, not DISPLAY
  423.                     so the users would never see them.  Make sure you move
  424.                     any ####.BBS files to the DISPLAY directory.
  425.  
  426. 12 April 96: 10.4:  Some people complained that the validation letters sent
  427.                     by the "V"alidate command were not private.  Now they
  428.                     are sent as private messages.
  429.  
  430. =============================================================================
  431.                                    CREDITS
  432. =============================================================================
  433.  
  434. Thanks to:
  435.  
  436.    Fire Escape for writing this manual, and pushing me to get UserScan
  437.    written!
  438.    Keith Kolbo for creating the original UserScan for 5.x (where are you
  439.    man!?!)
  440.    Mark Goodwin for creating TriBBS, and for releasing TBAPI and TDOOR!
  441.    Borland International for such an excellent development environment.
  442.  
  443. This program was written using Borland C++ 4.51, in large model, compiled
  444. for 8086 processors (for you OLD sysops), linked with TDOOR 3.0 and TBAPI
  445. 10.0.  No additional 3rd party tools are used.  Registered users receive
  446. complete source and .IDE file.
  447.